Formal Parameter | Type | Default | Required | Description |
appliesTo | STRING | false | This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
contextMenus | STRING | false | This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:
|
|
cssErrorMessage | STRING | error-message | false | Deprecated. This formal parameter is not referenced anywhere in the code This is the css name for the error message. Allowed Values: String value representing a css class name. It should be defined in a css file included in the page. |
cssErrorTitle | STRING | error-title | false | Deprecated. This formal parameter is not referenced anywhere in the code This is the css name for the error title. Allowed Values: String value representing a css class name. It should be defined in a css file included in the page. |
cssUseFileContent | BOOLEAN | false | false | This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content. Allowed Values: TRUE/FALSE. |
debugErrorFlags | INTEGER | 65535 | false | Indicates which extra debug information to include in case of an error. The flags are taken from the EnumWebAppDebugFlags enumeration. |
debugFlags | INTEGER | 0 | false | Indicates which debug information to include. The flags are taken from the EnumWebAppDebugFlags enumeration. |
dragMode | INTEGER | 0 | false | Indicates the drag mode that the component to render will have. Usage: This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include: |
expandEmbeddedFilter | BOOLEAN | false | false | Indicates whether or not to show simply the shortcut name or the expanded expression. |
extraInput | STRING | false | Indicates any extra inputs to be included in the forms generated by the transform. |
|
extraUrl | STRING | false | Indicates any extra parameters to be included in the links generated by the transform. |
|
globalCssErrorMessage | STRING | error-message | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all error messages. |
globalCssErrorTitle | STRING | error-title | false | Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore. CSS to be used in all Error titles. |
height | STRING | false | Indicates the default height of the component. If this is not a resizable component, this
is the height used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |
|
iframeEnabled | BOOLEAN | false | false | Indicates whether the transform supports iframe manipulations. |
imgError | STRING | jobError.gif | false | This is the Image to display when there bean is in Error status. Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. |
imgWait | STRING | ani_wait.gif | false | Deprecated. This value is not used anymore by the Transform as the wait image is included using css. Name of the image for the Processing icon on the Wait page. Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter. |
initialIndent | INTEGER | 0 | false | Deprecated. Indentation is not appended by Transforms anymore. Indicates the initial indentation of the HTML generated. |
orientation | INTEGER | 2 | false | Indicates the orientation the dialog to render will have. Usage: Possible values for this property and their meaning include: |
orientationsAllowed | INTEGER | 3 | false | Indicates the orientation modes allowed for the dialog to render. Usage: Possible values for this property and their meaning include: |
reportFilterTxtAreaCols | INTEGER | 65 | false | Parameter to specify the number of columns for the Report Filter Textarea. Allowed Values: integer values |
reportFilterTxtAreaRows | INTEGER | 5 | false | Parameter to specify the number of rows for the Report Filter Textarea. Allowed Values: integer values |
reportPathStyle | STRING | ObjectSimplePathStyle | false | Parameter to specify the Style name used to show the report path. This has to match one of the styles specified in the page config file. Allowed Values: any report style name from StyelCatalog.xml file. |
reportPromptDetailsStylePara | STRING | ReportPromptDetailsSummary | false | Parameter to specify the Style name used to show the prompt details. This has to match one of the styles specified in the page config file for this page. Allowed Values: any report style name from StyelCatalog.xml file. |
resizeLevel | INTEGER | 0 | false | Indicates whether the component can be resized vertically/horizontally or both or none.
Possible values are AbstractAppTransform.RESIZE_NONE , AbstractAppTransform.RESIZE_VERTICAL , AbstractAppTransform.RESIZE_HORIZONTAL ,
AbstractAppTransform.RESIZE_ALL |
scriptClass | STRING | false | Holds the name of the javaScript class (if any) to be associated with the component.
When the scriptClass is specified, a bone is registered on the page for this component.
A bone is the corresponding concept of a bean in Microstrategy's javascript environment. By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method. |
|
showHRLine1 | BOOLEAN | true | false | Flag used to decide if we need to show the first HR on the transform. Allowed Values: TRUE / FALSE |
showHRLine2 | BOOLEAN | true | false | Flag used to decide if we need to show the second HR on the transform. Allowed Values: TRUE / FALSE |
showHRLine3 | BOOLEAN | true | false | Flag used to decide if we need to show the third HR on the transform. Allowed Values: TRUE / FALSE |
showParentFolder | BOOLEAN | true | false | Flag used to decide if we need to show Report Parent Folder Name. Allowed Values: TRUE / FALSE |
showReportBaseFilterName | BOOLEAN | true | false | Flag used to decide if we need to show the Report Base Filter name. Allowed Values: TRUE / FALSE |
showReportDescription | BOOLEAN | true | false | Flag used to decide if we need to show the Report Description. Allowed Values: TRUE / FALSE |
showReportFilter | BOOLEAN | true | false | Flag used to decide if we need to show the Report Filter details. Allowed Values: TRUE / FALSE |
showReportFinishTime | BOOLEAN | true | false | Flag used to decide if we need to show the Report Finish time. Allowed Values: TRUE / FALSE |
showReportID | BOOLEAN | true | false | Flag used to decide if we need to show the total ReportID. Allowed Values: TRUE / FALSE |
showReportLimit | BOOLEAN | true | false | Flag used to decide if we need to show the Report Template Limit. Allowed Values: TRUE / FALSE |
showReportMessage | BOOLEAN | true | false | Flag used to decide if we need to show the Report MessageID. Allowed Values: TRUE / FALSE |
showReportMessageCreated | BOOLEAN | true | false | Flag used to decide if we need to show the Report Message Created time. Allowed Values: TRUE / FALSE |
showReportMessageUpdated | BOOLEAN | true | false | Flag used to decide if we need to show the Report Message Updated time. Allowed Values: TRUE / FALSE |
showReportName | BOOLEAN | true | false | Flag used to decide if we need to show Report Name. Allowed Values: TRUE / FALSE |
showReportOwner | BOOLEAN | true | false | Flag used to decide if we need to show the Report Owner. Allowed Values: TRUE / FALSE |
showReportPath | BOOLEAN | true | false | Flag used to decide if we need to show the Report Path. Allowed Values: TRUE / FALSE |
showReportPromptDetails | BOOLEAN | true | false | Flag used to decide if we need to show the Report Prompt details. Allowed Values: TRUE / FALSE |
showReportSQL | BOOLEAN | true | false | Flag used to decide if we need to show the Report SQL details. Allowed Values: TRUE / FALSE |
showReportStartTime | BOOLEAN | true | false | Flag used to decide if we need to show the Report Start time. Allowed Values: TRUE / FALSE |
showReportStatus | BOOLEAN | true | false | Flag used to decide if we need to show the Report Status. Allowed Values: TRUE / FALSE |
showReportTemplate | BOOLEAN | true | false | Flag used to decide if we need to show the Report Template name. Allowed Values: TRUE / FALSE |
showReportTemplateDetails | BOOLEAN | true | false | Flag used to decide if we need to show the Report Template details. Allowed Values: TRUE / FALSE |
showReportTotCols | BOOLEAN | true | false | Flag used to decide if we need to show the total columns in the report. Allowed Values: TRUE / FALSE |
showReportTotRows | BOOLEAN | true | false | Flag used to decide if we need to show the total rows in the report. Allowed Values: TRUE / FALSE |
showReportViewFilter | BOOLEAN | true | false | Flag used to decide if we need to show the Report View Filter details. Allowed Values: TRUE / FALSE |
showServerName | BOOLEAN | true | false | Flag used to decide if we need to show the Server Name. Allowed Values: TRUE / FALSE |
sqlTxtAreaCols | INTEGER | 65 | false | Parameter to specify the number of columns for the SQL Textarea. Allowed Values: integer values |
sqlTxtAreaRows | INTEGER | 15 | false | Parameter to specify the number of rows for the SQL Textarea. Allowed Values: integer values |
templateDetailsTxtAreaCols | INTEGER | 65 | false | Parameter to specify the number of columns for the Template Details Textarea. Allowed Values: integer values |
templateDetailsTxtAreaRows | INTEGER | 5 | false | Parameter to specify the number of rows for the Template Details Textarea. Allowed Values: integer values |
type | STRING | false | This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page). Possible values for this property are bone ids, its usage depends on the page. |
|
useBuiltInFormat | BOOLEAN | true | false | This is the flag used in the transform to specify whether to use the formatting info from the report definition. Out of box, we map the first preference in Grid preferences section to this formal parameter. If it's TRUE, WebCSSHelper.getCSS() will give the css class definitions, which is from report formatting defintion. If it's FALSE, a specified css file will give the css class definitions, which is what formal paramter cssFile means. Allowed Values: TRUE/FALSE. |
useDHTML | BOOLEAN | true | false | Indicates whether to use DHTML on the output. If not set, the bean's OutputFormat() method will be used. |
viewFilterTxtAreaCols | INTEGER | 65 | false | Parameter to specify the number of columns for the View Filter Textarea. Allowed Values: integer values |
width | STRING | false | Indicates the default width of the component. If this is not a resizable component, this
is the width used. If if it resizable, though, the user might change its width
using javascript and the value is saved in a preference; thereafter the Transform
will use this new value for this component. |